home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cato / Xm / Composite.z / Composite
Encoding:
Text File  |  2002-10-03  |  10.4 KB  |  199 lines
  1.  
  2.  
  3.  
  4.      CCCCoooommmmppppoooossssiiiitttteeee((((3333XXXX))))             UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV             CCCCoooommmmppppoooossssiiiitttteeee((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           CCCCoooommmmppppoooossssiiiitttteeee - The Composite widget class
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////XXXXmmmm....hhhh>>>>
  13.  
  14.  
  15.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  16.           This page documents version 1.2 of the Motif library.
  17.  
  18.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  19.           Composite widgets are intended to be containers for other
  20.           widgets and can have an arbitrary number of children.  Their
  21.           responsibilities (implemented either directly by the widget
  22.           class or indirectly by Intrinsics functions) include:
  23.  
  24.  
  25.             +o  Overall management of children from creation to
  26.                destruction.
  27.  
  28.             +o  Destruction of descendants when the composite widget is
  29.                destroyed.
  30.  
  31.             +o  Physical arrangement (geometry management) of a
  32.                displayable subset of managed children.
  33.  
  34.             +o  Mapping and unmapping of a subset of the managed
  35.                children.  Instances of composite widgets need to
  36.                specify the order in which their children are kept.
  37.                For example, an application may want a set of command
  38.                buttons in some logical order grouped by function, and
  39.                it may want buttons that represent filenames to be kept
  40.                in alphabetical order.
  41.  
  42.  
  43.         CCCCllllaaaasssssssseeeessss
  44.           Composite inherits behavior and resources from CCCCoooorrrreeee.
  45.  
  46.           The class pointer is ccccoooommmmppppoooossssiiiitttteeeeWWWWiiiiddddggggeeeettttCCCCllllaaaassssssss.
  47.  
  48.           The class name is CCCCoooommmmppppoooossssiiiitttteeee.
  49.  
  50.         NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  51.           The following table defines a set of widget resources used
  52.           by the programmer to specify data.  The programmer can also
  53.           set the resource values for the inherited classes to set
  54.           attributes for this widget.  To reference a resource by name
  55.           or by class in a .Xdefaults file, remove the XXXXmmmmNNNN or XXXXmmmmCCCC
  56.           prefix and use the remaining letters.  To specify one of the
  57.           defined values for a resource in a .Xdefaults file, remove
  58.           the XXXXmmmm prefix and use the remaining letters (in either
  59.           lowercase or uppercase, but include any underscores between
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      CCCCoooommmmppppoooossssiiiitttteeee((((3333XXXX))))             UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV             CCCCoooommmmppppoooossssiiiitttteeee((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           words).  The codes in the access column indicate if the
  75.           given resource can be set at creation time (C), set by using
  76.           XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (S), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (G), or is
  77.           not applicable (N/A).
  78.  
  79.                              CCCCoooommmmppppoooossssiiiitttteeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  80.      NNNNaaaammmmeeee                CCCCllllaaaassssssss               TTTTyyyyppppeeee          DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  81.      ______________________________________________________________________
  82.      XmNchildren         XmCReadOnly         WidgetList    NULL      G
  83.      XmNinsertPosition   XmCInsertPosition   XtOrderProc   NULL      CSG
  84.      XmNnumChildren      XmCReadOnly         Cardinal      0         G
  85.  
  86.  
  87.           XXXXmmmmNNNNcccchhhhiiiillllddddrrrreeeennnn
  88.                     A read-only list of the children of the widget.
  89.  
  90.           XXXXmmmmNNNNiiiinnnnsssseeeerrrrttttPPPPoooossssiiiittttiiiioooonnnn
  91.                     Points to the XXXXttttOOOOrrrrddddeeeerrrrPPPPrrrroooocccc function described
  92.                     below.
  93.  
  94.           XXXXmmmmNNNNnnnnuuuummmmCCCChhhhiiiillllddddrrrreeeennnn
  95.                     A read-only resource specifying the length of the
  96.                     list of children in XXXXmmmmNNNNcccchhhhiiiillllddddrrrreeeennnn.
  97.  
  98.  
  99.           The following procedure pointer in a composite widget
  100.           instance is of type XXXXttttOOOOrrrrddddeeeerrrrPPPPrrrroooocccc:
  101.  
  102.           CCCCaaaarrrrddddiiiinnnnaaaallll ((((**** XXXXttttOOOOrrrrddddeeeerrrrPPPPrrrroooocccc)))) ((((_w_i_d_g_e_t))))
  103.                WWWWiiiiddddggggeeeetttt    _w;
  104.  
  105.  
  106.           _w      Specifies the widget.
  107.  
  108.  
  109.           Composite widgets that allow clients to order their children
  110.           (usually homogeneous boxes) can call their widget instance's
  111.           insert_position procedure from the class's insert_child
  112.           procedure to determine where a new child should go in its
  113.           children array.  Thus, a client of a composite class can
  114.           apply different sorting criteria to widget instances of the
  115.           class, passing in a different insert_position procedure when
  116.           it creates each composite widget instance.
  117.  
  118.           The return value of the insert_position procedure indicates
  119.           how many children should go before the widget.  Returning
  120.           _z_e_r_o indicates that the widget should go before all other
  121.           children; returning num_children indicates that it should go
  122.           after all other children.  The default insert_position
  123.           function returns num_children and can be overridden by a
  124.           specific composite widget's resource list or by the argument
  125.           list provided when the composite widget is created.
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      CCCCoooommmmppppoooossssiiiitttteeee((((3333XXXX))))             UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV             CCCCoooommmmppppoooossssiiiitttteeee((((3333XXXX))))
  137.  
  138.  
  139.  
  140.         IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
  141.           Composite inherits behavior and resources from the following
  142.           superclass.  For a complete description of each resource,
  143.           refer to the manual page for that superclass.
  144.  
  145.                                                    CCCCoooorrrreeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  146.      NNNNaaaammmmeeee                            CCCCllllaaaassssssss                           TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  147.      ______________________________________________________________________________________________________________
  148.      XmNaccelerators                 XmCAccelerators                 XtAccelerators   dynamic                CSG
  149.      XmNancestorSensitive            XmCSensitive                    Boolean          dynamic                G
  150.      XmNbackground                   XmCBackground                   Pixel            dynamic                CSG
  151.      XmNbackgroundPixmap             XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  152.      XmNborderColor                  XmCBorderColor                  Pixel            XtDefaultForeground    CSG
  153.      XmNborderPixmap                 XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  154.      XmNborderWidth                  XmCBorderWidth                  Dimension        1                      CSG
  155.      XmNcolormap                     XmCColormap                     Colormap         dynamic                CG
  156.      XmNdepth                        XmCDepth                        int              dynamic                CG
  157.      XmNdestroyCallback              XmCCallback                     XtCallbackList   NULL                   C
  158.      XmNheight                       XmCHeight                       Dimension        dynamic                CSG
  159.      XmNinitialResourcesPersistent   XmCInitialResourcesPersistent   Boolean          True                   C
  160.      XmNmappedWhenManaged            XmCMappedWhenManaged            Boolean          True                   CSG
  161.      XmNscreen                       XmCScreen                       Screen *         dynamic                CG
  162.      XmNsensitive                    XmCSensitive                    Boolean          True                   CSG
  163.      XmNtranslations                 XmCTranslations                 XtTranslations   dynamic                CSG
  164.      XmNwidth                        XmCWidth                        Dimension        dynamic                CSG
  165.      XmNx                            XmCPosition                     Position         0                      CSG
  166.      XmNy                            XmCPosition                     Position         0                      CSG
  167.  
  168.         TTTTrrrraaaannnnssssllllaaaattttiiiioooonnnnssss
  169.           There are no translations for Composite.
  170.  
  171.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  172.           CCCCoooorrrreeee((((3333XXXX)))).
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 4/30/98)
  196.  
  197.  
  198.  
  199.